Skip to main content

Transfer Order API - Asset

Version 1.0 — May 2024

Authentication: All requests require an IdToken from the Login API. See Authentication to obtain one and Errors for authorization errors.

Create Asset Transfer Order API​

Create Asset Transfer Order API allows to create the transfer order and keep track of the items associated with the transfer order.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringTransfer order numberYes
transferFromIdStringSource locationNo
transferToIdStringDestination locationNo
entriesArrayList of assets and their quantities (view table below)Yes
customPropertiesAWSJSONAdditional properties applicable to transfer ordersNo

entries​

PropertyTypeDescriptionRequired
assetIdStringAsset identifierYes
totalQuantityNumberQuantity of the assetYes
trackerSerialsArray of StringList of EPCs for the asset as part of the transfer orderNo
unitStringUnit of measure (if applicable)No

Headers

Authorization – $idToken

Request Body​

mutation createAssetTransferOrder {
createAssetTransferOrder(
input: CreateAssetTransferOrderInput!
) {
assetTransferOrder {
cancelledDate
creationDate
id
receiveDate
startDate
transferFrom {
customProperties
description
id
name
}
status
lastUpdatedDate
entries {
lastUpdatedDate
asset {
customProperties
description
name
id
}
inventory {
trackerSerial
id
name
description
}
inTransitQuantity
receivedQuantity
unit
totalQuantity
}
transferTo {
customProperties
description
id
name
}
}
}
}
----------------------------------------------------------------------

CreateAssetTransferOrderInput {
transferFromId: "Location A",
transferToId: "Location B",
entries: [
{
assetId: "Asset-123",
totalQuantity: 3,
trackerSerials: ["EPC1", "EPC2", "EPC3"],
unit: "EA"
}
],
id: "TEST_ASSET_TRANSFER_ORDER"
}

Status Code - 200

Response Body​

AssetTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
entries: [AssetTransferOrderEntry!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.

Additional 200-Level Errors​

ErrorError descriptionError code
ValidationErrorNo id provided, no entries, quantity ≤ 0, no asset, duplicate asset200
ResourceNotFoundErrorTracker serial does not exist200
UnexpectedErrorSome unexpected things happened on create, duplicate locations with the same identifier200
LocationNotFoundErrorFrom/to location not found200
ResourceAlreadyExistErrorTransfer order with this identifier already exists200

Get Transfer Order API​

Get Transfer Order API allows to retrieve the transfer order and view its status.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringTransfer order numberYes

Headers

Authorization – $idToken

Request Body​

query assetTransferOrder($id: String) {
assetTransferOrder(input: { id: $id }) {
assetTransferOrder {
cancelledDate
creationDate
id
receivedDate
startDate
transferFrom {
customProperties
description
id
name
}
status
lastUpdatedDate
entries {
lastUpdatedDate
asset {
customProperties
description
id
name
}
inventory {
trackerSerial
id
name
description
}
inTransitQuantity
receivedQuantity
unit
totalQuantity
}
transferTo {
customProperties
description
id
name
}
}
}
}

Status Code - 200

Response Body​

AssetTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
entries: [AssetTransferOrderEntry!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.

Additional 200-Level Errors​

ErrorError descriptionError code
ValidationErrorNo id provided200
ResourceNotFoundErrorTransfer order not found200

List Transfer Orders API​

List Transfer Orders API allows to retrieve all the transfer orders and view their statuses.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
filterStringFilter for transfer order propertiesNo
nextTokenStringPagination supportNo

Headers

Authorization – $idToken

Request Body​

query assetTransferOrders($filter: String, $nextToken: String) {
assetTransferOrders(input: { filter: $filter, nextToken: $nextToken }) {
assetTransferOrders {
cancelledDate
creationDate
id
receivedDate
startDate
transferFrom {
customProperties
description
id
name
}
status
lastUpdatedDate
entries {
lastUpdatedDate
asset {
customProperties
description
id
name
}
inventory {
trackerSerial
id
name
description
}
inTransitQuantity
receivedQuantity
unit
totalQuantity
}
transferTo {
customProperties
description
id
name
}
}
}
}

Status Code - 200

Response Body​

AssetTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
entries: [AssetTransferOrderEntry]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.


Delete Transfer Order API​

Delete Transfer Order API allows to remove the transfer order.

Endpoint Details​

  • URL: https://api.xemelgo.com/graphql
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
idStringTransfer order numberYes

Headers

Authorization – $idToken

Request Body​

mutation deleteAssetTransferOrder {
deleteAssetTransferOrder(input: { id: "TEST_ASSET_TRANSFER_ORDER" }) {
assetTransferOrder {
cancelledDate
creationDate
id
receivedDate
startDate
transferFrom {
customProperties
description
id
name
}
status
lastUpdatedDate
entries {
lastUpdatedDate
asset {
customProperties
description
id
name
}
inventory {
trackerSerial
id
name
description
}
inTransitQuantity
receivedQuantity
unit
totalQuantity
}
transferTo {
customProperties
description
id
name
}
}
}
}

Status Code - 200

Response Body​

AssetTransferOrder {
id: String
status: TransferOrderStatus
transferFrom: LocationV2
transferTo: LocationV2
creationDate: AWSTimestamp
startDate: AWSTimestamp
completedDate: AWSTimestamp
cancelledDate: AWSTimestamp
entries: [AssetTransferOrderEntry!]!
lastUpdatedDate: AWSTimestamp
customProperties: AWSJSON
}

Errors​

See authorization errors.

Additional 200-Level Errors​

ErrorError descriptionError code
ValidationErrorNo id provided200
ResourceNotFoundErrorTransfer order not found200